////////////////////////////////////////////////////////////////////////////////
// Copyright 2006 CORE Solutions Limited
// All rights reserved.
// PROPRIETARY AND CONFIDENTIAL INFORMATION.
// Use is subject to license terms.
//
// FUNCTION ID      :   REMARK
// AUTHOR           :   Ric Yik 
// DATE CREATE      :   2006/01/05
// DESCRIPTION      :   a DAO file for the function, REMARK
//                  :   
//                  :   
//                  :   
//
// MODIFICATION HISTORY:
// DATE         AUTHOR          VERSION NO.         COMMENT
// -----------  --------------  ------------------  -------------------
// 2006/01/05   Ric Yik         1.0                 source is generated.
//
//
//
////////////////////////////////////////////////////////////////////////////////

package com.erp.app.setup.remark.dao;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

import com.erp.app.common.ProjectConstants;
import com.erp.app.setup.remark.criteria.RemarkHdrSrchCriteria;
import com.erp.app.setup.remark.pk.RemarkHdrPk;
import com.erp.app.setup.remark.vo.RemarkHdrVo;
import com.erp.framework.exceptions.FindRecordException;
import com.erp.framework.model.criteria.SimpleBaseSrchCriteria;
import com.erp.framework.model.dao.SimpleSearchMaintStyleDao;
import com.erp.framework.model.vo.ChildList;
import com.erp.framework.model.vo.SimpleBaseVo;
import com.erp.framework.types.CustomSqlDate;

/**
 * <p>
 * A <strong>DAO</strong>(Data Access Object) abstracts and encapsulates all
 * access to the persistent store. The DAO manages the connection with the data
 * source to obtain and store data. Also, the DAO implements the access
 * mechanism required to work with the data source, and always provides a
 * uniform API to its clients.
 * 
 * @author Ric Yik
 * @version 1.0 2006/01/05
 * @since FrameWork 1.0
 * 
 */
public class RemarkHdrDao extends SimpleSearchMaintStyleDao {

    /**
     * Returns the SQL select statement.
     * 
     * @param obj
     *            the searching criteria
     * @return a string containing sql query
     * 
     * @author Ric Yik
     * @since FrameWork 1.0
     */
    protected String sqlQuery(SimpleBaseSrchCriteria obj) {

        RemarkHdrSrchCriteria criteria = (RemarkHdrSrchCriteria) obj;
        String sql = "";
        String whereClause = toWhereClause(criteria);
        String groupByClause = "";
        String orderByClause = "ORDER BY COMPANY_CODE, REMARK_MASTER_CODE";

        if (!criteria.isSearchResult()) {
            sql = "SELECT COMPANY_CODE, REMARK_MASTER_CODE, REMARK_MASTER_DESC, STATUS, DC_IND, "
                    + "DC_DATE, CREATE_USER, CREATE_DATE, UPDATE_USER, UPDATE_DATE "
                    + "FROM T_REMARK_HDR "
                    + whereClause
                    + groupByClause
                    + orderByClause;
        } else {
            sql = "SELECT COMPANY_CODE, REMARK_MASTER_CODE, STATUS "
                    + "FROM T_REMARK_HDR " + whereClause + groupByClause
                    + orderByClause;
        }
        //super.logSqlQuery(sql);
        return sql;
    }

    /**
     * Returns the where clause of a SQL select statement.
     * 
     * @param obj
     *            the searching criteria
     * @return a string containing the where clause
     * 
     * @author Ric Yik
     * @since FrameWork 1.0
     */
    protected String toWhereClause(RemarkHdrSrchCriteria crit) {

        RemarkHdrSrchCriteria criteria = (RemarkHdrSrchCriteria) crit;
        StringBuffer whereClause = new StringBuffer();

        if (criteria.getSrchCompanyCode() != null) {
            whereClause.append(whereClause.length() == 0 ? "WHERE " : "AND ");
            whereClause.append(" COMPANY_CODE = '" + criteria.getSrchCompanyCode().trim().toUpperCase() + "' ");
        }

        if (criteria.getSrchRemarkMasterCodeFr() != null) {
            whereClause.append(whereClause.length() == 0 ? "WHERE " : "AND ");
            whereClause.append(" REMARK_MASTER_CODE = '" + criteria.getSrchRemarkMasterCodeFr().trim().toUpperCase() + "' ");
        }

        if (criteria.getSrchStatus() != null) {
            whereClause.append(whereClause.length() == 0 ? "WHERE " : "AND ");
            whereClause.append(" STATUS = '" + criteria.getSrchStatus().trim().toUpperCase() + "' ");
        }

        return whereClause.toString();
    }

    /**
     * Returns an array list of child VOs by the parent
     * 
     * @param parent
     *            the incoming parent VO
     * @param conn
     *            the database connection
     * @return an array list of child VOs
     * 
     * @author Ric Yik
     * @since FrameWork 1.0
     */
    public ChildList selectByParent(SimpleBaseVo parent, Connection conn)
            throws FindRecordException {

        return null;
    }

    /**
     * Constructs a string of SQL insert statement
     * 
     * @return a string of SQL insert statement
     * 
     * @author Ric Yik
     * @since FrameWork 1.0
     */
    protected String sqlInsert() {

        String sql = "INSERT INTO T_REMARK_HDR ("
                + "COMPANY_CODE, REMARK_MASTER_CODE, REMARK_MASTER_DESC, STATUS, DC_IND, "
                + "DC_DATE, CREATE_USER, CREATE_DATE, UPDATE_USER, UPDATE_DATE) "
                + "VALUES (" + "?, ?, ?, ?, 'NO', " + "?, ?, SYSDATE, ?, ?"
                + ")";

        //super.logSqlQuery(sql);
        return sql;
    }

    /**
     * Sets the values for a SQL insert or update statement.
     * 
     * @param pStmt
     *            the incoming prepared statement
     * @param obj
     *            the incoming VO
     * 
     * @author Ric Yik
     * @since FrameWork 1.0
     */
    protected void setValuesForInsertAndModify(PreparedStatement pStmt,
            Object obj, String opType) throws SQLException {

        RemarkHdrVo vo = (RemarkHdrVo) obj;
        int i = 1;

        pStmt.setString(i++, vo.getCompanyCode());
        pStmt.setString(i++, vo.getRemarkMasterCode());
        setNullableString(pStmt, i++, vo.getRemarkMasterDesc());
        setNullableString(pStmt, i++, vo.getStatus());

        if (ProjectConstants.DB_OP_UPDATE.equals(opType))
            setNullableString(pStmt, i++, vo.getDcInd());
        setNullableDate(pStmt, i++, vo.getDcDate());
        setNullableString(pStmt, i++, vo.getCreateUser());

        if (ProjectConstants.DB_OP_UPDATE.equals(opType))
            setNullableTimestamp(pStmt, i++, vo.getCreateDate());

        setNullableString(pStmt, i++, vo.getUpdateUser());

        if (ProjectConstants.DB_OP_INSERT.equals(opType))
            setNullableTimestamp(pStmt, i++, vo.getUpdateDate());

        if (ProjectConstants.DB_OP_UPDATE.equals(opType)) {
            pStmt.setString(i++, vo.getCompanyCode());
            pStmt.setString(i++, vo.getRemarkMasterCode());
            setNullableTimestamp(pStmt, i++, vo.getUpdateDate());
        }
    }

    /**
     * Sets the values for a SQL insert statement.
     * 
     * @param pStmt
     *            the incoming prepared statement
     * @param obj
     *            the incoming VO
     * 
     * @author Ric Yik
     * @since FrameWork 1.0
     */
    protected void setValuesForInsert(PreparedStatement pStmt, Object obj)
            throws SQLException {

        setValuesForInsertAndModify(pStmt, obj, ProjectConstants.DB_OP_INSERT);
    }

    /**
     * Constructs a string of SQL update statement
     * 
     * @return a string of SQL update statement
     * 
     * @author Ric Yik
     * @since FrameWork 1.0
     */
    protected String sqlUpdate() {

        String sql = "UPDATE T_REMARK_HDR SET COMPANY_CODE=?, REMARK_MASTER_CODE=?, REMARK_MASTER_DESC=?, STATUS=?, DC_IND=?, "
                + "DC_DATE=?, CREATE_USER=?, CREATE_DATE=?, UPDATE_USER=?, UPDATE_DATE=SYSDATE "
                + "WHERE COMPANY_CODE=? AND REMARK_MASTER_CODE=? "
                + "AND (UPDATE_DATE IS NULL OR UPDATE_DATE = ?) ";

        //super.logSqlQuery(sql);
        return sql;
    }

    /**
     * Sets the values for a SQL update statement.
     * 
     * @param pStmt
     *            the incoming prepared statement
     * @param obj
     *            the incoming VO
     * 
     * @author Ric Yik
     * @since FrameWork 1.0
     */
    protected void setValuesForModify(PreparedStatement pStmt, Object obj)
            throws SQLException {

        setValuesForInsertAndModify(pStmt, obj, ProjectConstants.DB_OP_UPDATE);
    }

    /**
     * Constructs a string of SQL delete statement
     * 
     * @return a string of SQL update statement
     * 
     * @author Ric Yik
     * @since FrameWork 1.0
     */
    protected String sqlDelete() {
        String sql = "DELETE FROM T_REMARK_HDR WHERE COMPANY_CODE=? AND REMARK_MASTER_CODE=? ";

        //super.logSqlQuery(sql);
        return sql;
    }

    /**
     * Sets the values for a SQL delete statement.
     * 
     * @param pStmt
     *            the incoming prepared statement
     * @param obj
     *            the incoming VO
     * 
     * @author Ric Yik
     * @since FrameWork 1.0
     */
    protected void setValuesForDelete(PreparedStatement pStmt, Object obj)
            throws SQLException {

        RemarkHdrVo vo = (RemarkHdrVo) obj;
        int i = 1;

        pStmt.setString(i++, vo.getCompanyCode());
        pStmt.setString(i++, vo.getRemarkMasterCode());
    }

    /**
     * Constructs a string of SQL select statement
     * 
     * @return a string of SQL select statement
     * 
     * @author Ric Yik
     * @since FrameWork 1.0
     */
    protected String sqlFind() {

        String sql = "SELECT COMPANY_CODE, REMARK_MASTER_CODE, REMARK_MASTER_DESC, STATUS, DC_IND, "
                + "DC_DATE, CREATE_USER, CREATE_DATE, UPDATE_USER, UPDATE_DATE "
                + "FROM T_REMARK_HDR "
                + "WHERE COMPANY_CODE=? AND REMARK_MASTER_CODE=? "
                + "ORDER BY COMPANY_CODE, REMARK_MASTER_CODE";

        //super.logSqlQuery(sql);
        return sql;
    }

    /**
     * Sets the values for a SQL select statement for finding by primary key.
     * 
     * @param pStmt
     *            the incoming prepared statement
     * @param obj
     *            the incoming PK
     * 
     * @author Ric Yik
     * @since FrameWork 1.0
     */
    protected void setValuesForFind(PreparedStatement pStmt, Object obj)
            throws SQLException {

        RemarkHdrPk pk = (RemarkHdrPk) obj;
        int i = 1;

        pStmt.setString(i++, pk.getCompanyCode());
        pStmt.setString(i++, pk.getRemarkMasterCode());
    }

    /**
     * Constructs a string of SQL select statement
     * 
     * @return a string of SQL select statement
     * 
     * @author Ric Yik
     * @since FrameWork 1.0
     */
    protected String sqlList() {

        return null;
    }

    /**
     * Sets the values for a SQL select statement for finding child tables.
     * 
     * @param pStmt
     *            the incoming prepared statement
     * @param obj
     *            the incoming parent PK
     * 
     * @author Ric Yik
     * @since FrameWork 1.0
     */
    protected void setValuesForList(PreparedStatement pStmt, Object obj)
            throws SQLException {

    }

    /**
     * Sets the values of a result set to a vo for a search screen
     * 
     * @param rs
     *            the incoming result set
     * @return a vo containing the result set values
     * 
     * @author Ric Yik
     * @since FrameWork 1.0
     */
    protected SimpleBaseVo getSearchResultSetValues(ResultSet rs)
            throws SQLException {
        RemarkHdrVo vo = new RemarkHdrVo();

        vo.setCompanyCode(rs.getString("COMPANY_CODE"));
        vo.setRemarkMasterCode(rs.getString("REMARK_MASTER_CODE"));
        vo.setStatus(rs.getString("STATUS"));

        return vo;
    }

    /**
     * Sets the values of a result set to a vo
     * 
     * @param rs
     *            the incoming result set
     * @return a vo containing the result set values
     * 
     * @author Ric Yik
     * @since FrameWork 1.0
     */
    protected SimpleBaseVo getResultSetValues(ResultSet rs) throws SQLException {

        RemarkHdrVo vo = new RemarkHdrVo();

        vo.setCompanyCode(rs.getString("COMPANY_CODE"));
        vo.setRemarkMasterCode(rs.getString("REMARK_MASTER_CODE"));
        vo.setRemarkMasterDesc(rs.getString("REMARK_MASTER_DESC"));
        vo.setStatus(rs.getString("STATUS"));
        vo.setDcInd(rs.getString("DC_IND"));
        vo.setDcDate(CustomSqlDate.customize(rs.getDate("DC_DATE")));
        vo.setCreateUser(rs.getString("CREATE_USER"));
        vo.setCreateDate(rs.getTimestamp("CREATE_DATE"));
        vo.setUpdateUser(rs.getString("UPDATE_USER"));
        vo.setUpdateDate(rs.getTimestamp("UPDATE_DATE"));

        return vo;
    }

}
